Back to Asset Essentials Main Menu

Smart Assets Integration for IoT Work Orders

This guide explains how to use Smart Assets to create Work Orders (WOs) in Asset Essentials (AE) when an IoT system detects a reading anomaly.

Smart Assets is the required integration mechanism for this process and replaces direct real time API calls to Asset Essentials for creating Work Orders. The integration ensures a reliable, validated, and scalable way to convert IoT alerts into Work Orders.

Integration Flow

This section provides a high level overview of how IoT alerts are processed and converted into Work Orders.

  • The IoT system detects a reading anomaly.

  • The IoT system sends the anomaly alert to Smart Assets.

  • Smart Assets validates tenant and asset mappings.

  • If all required mappings exist, Smart Assets creates a Work Order in Asset Essentials.

Review this flow to understand the overall behavior before proceeding with configuration or API usage.

Prerequisites

Before IoT alerts can create Work Orders, the following prerequisites must be completed:

  • The Asset Essentials tenant is onboarded in Smart Assets.

  • All required asset details are onboarded in Smart Assets.

  • Brightly has mapped AE tenant and asset IDs to IoT provider IDs (if provider IDs are used).

  • An API key has been issued by Brightly and stored securely.

Important: Do not proceed with integration steps until all prerequisites are met. Missing prerequisites will prevent Work Orders from being created.

IoT Alert API Details

API Endpoint

Send anomaly events to this endpoint: 

 POST https://v1-smartassets-platform.dudesolutions.io/events/reading-anomalies

Request Headers

Include the following headers with every request:

  • x-api-key: <api-key>

  • Content-Type: application/json

Ensure the API key provided by Brightly is used and kept secure.

Request Payload

Required Identifier Combinations

Each request must include one of these ID combinations:

  • assetId and tenant

OR

  • providerTenantId and providerAssetId

Requests missing required identifiers or mappings will not result in Work Order creation.

Required Anomaly Details

Include additional anomaly details such as:

  • asset ID

  • provider asset ID

  • alert name

  • alert details

  • tenant ID

  • provider tenant ID

  • alert ID

  • provider code

  • product code (AE)

Requests missing required identifiers or mappings will not result in Work Order creation.

Example Request

Use this example as a reference when constructing your API requests.

 curl --location 'https://v1-smartassets-platform.dudesolutions.io/events/reading-anomalies' </span>
--header 'x-api-key: <api-key>' </span>
--header 'Content-Type: application/json' </span>
--data '{
  "assetId": "ReadingAnomalyTest111",
  "providerAssetId": "123456789",
  "anomalyName": "Temperature Anomaly",
  "anomalyDetails": "Temperature breached 90C for Device 001",
  "tenant": "ReadingAnomalyTest",
  "providerTenantId": "54321",
  "anomalyId": "2132543",
  "providerCode": "apiprovider",
  "productCode": "AE"
}'

Enabling IoT Work Orders

Follow these steps to enable IoT-based WO creation:

  • Tenant onboarding: Brightly onboards the AE tenant in Smart Assets. Confirm tenant onboarding is complete before configuring mappings or sending alerts.

  • Tenant mapping (optional): If IoT provider uses a provider tenant ID, Brightly maps it to the AE tenant ID. Skip this step only if your IoT provider does not use tenant level identifiers.

  • Asset onboarding: Brightly and the client work together to onboard assets in Smart Assets. Ensure all assets that may generate alerts are onboarded before sending anomaly events.

  • Asset mapping (optional): If your IoT provider uses provider asset IDs, Brightly and the client map them to AE asset IDs. Asset mapping must be completed before alerts for those assets can create Work Orders.

  • Send anomaly events: The client sends anomaly alerts to Smart Assets using the API. Only send anomaly events after confirming tenant and asset mappings are in place.

  • Add new assets later: For new assets, repeat the asset onboarding and mapping steps. New assets must be onboarded and mapped before sending alerts for them.

If provider tenant ID and provider asset ID are not available, the optional mapping steps can be skipped.

Important Notes

Review these notes to avoid common integration errors.

  • Smart Assets is required for IoT based Work Order creation.

  • Direct real time API calls to Asset Essentials are not recommended.

  • Work Orders are created only when required mappings already exist.

  • This integration affects Work Order creation only, not updates.

FAQ

Q: Is this required?

A: Yes. Smart Assets is the required path for this process.

Q: Can we call Asset Essentials directly?

A: No. Direct real-time API calls are not recommended for this use case.

Q: What happens if mappings are missing?

A: A Work Order will not be created.

Q: Do new assets need setup?

A: Yes. New assets must be onboarded and mapped before they can be used.

Q: Does this change impact only the work order creation process?

A: Yes. There are no changes to updating work orders at this time. Any future changes will be communicated when available.